home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / ddmenu40.zip / DRAGDOOR.DOC < prev    next >
Text File  |  1990-01-11  |  21KB  |  604 lines
  1.  
  2.                              THE DRAGON'S DOOR MENU
  3.                                SYSOP DOCUMENTATION
  4.  
  5.  
  6.                             VERSION 4.0, JANUARY 1990
  7.                      COPYRIGHT (c) 1990, ALL RIGHTS RESERVED
  8.                              BY CHESTER H. JOHNSON
  9.  
  10.                          FOR USE WITH RBBS 16.X & 17.X
  11.  
  12.  
  13.  
  14.  
  15. WARNING!:  Starting with version 3.3 you will need the DTR-patched BRUN45.EXE
  16. file somewhere in you path.  This was done to conserve space in the archive.
  17. I saved 148,473 bytes in the archive by doing this, effectively cutting the
  18. download time to 1/4 of what it would have been.
  19.  
  20.  
  21.  
  22. Section 1:
  23. ==========
  24.  
  25.  
  26. Warranty:
  27. ---------
  28.  
  29.      I make no warranties, express or implied, as to the mercantibility or
  30. suitability for any purpose of this product.  I am not liable in any way for
  31. any damage or loss resulting from the use of this product.  I can not be held
  32. responsible for such damages or loss.  This program is provided AS-IS and is
  33. used at your own descretion and risk only.
  34.  
  35.  
  36. Disclaimer:
  37. -----------
  38.  
  39.      This program is "Freeware", which means that you can copy and use this
  40. program as long as no fee is charged for the program itself (but a nominal
  41. copying charge of up to $1.00 is allowed).  In other words:  I am the only
  42. person who can charge for the program, and I choose to give it away, free of
  43. charge.  I still retain the rights to the source code and all the routines
  44. therein.  You may not modify or borrow these routines without my express
  45. written consent.
  46.  
  47.      RBBS-PC (r) and RBBS(r) are registered trademarks of D. Thomas Mack.
  48. Wildcat!(r) is a registered trademark of Mustang Software.  PC-Board(r) is a
  49. registered trademark of Clark Development Co.  I have not put the "(r)"
  50. everywhere it should be, but this is not in an attempt to infringe on their
  51. copyrights, this was done because I am not in the habbit of doing that. Apple
  52. (tm) is a registered trademark of Apple Computer Corporation.
  53.  
  54.  
  55.  
  56. Section 2:
  57. ==========
  58.  
  59.  
  60. Why I wrote it:
  61. ---------------
  62.  
  63.      Around March (1989) I decided to convert from running an Apple bulletin
  64. board to running an RBBS board.  In less than a month after that, I tried my
  65. hand at running doors.
  66.      During the first 2 months I got 4 doors running and I tried several door
  67. menu programs, and I had almost no success with them.
  68.      Finally (after about 3 months) I decided to write my own.  I decided
  69. that it should be able to do several things.  Here are some of them:
  70.  
  71.                 1) Be fairly easy to set up (getting this better all the time)
  72.                 2) Let you restrict access to each door by security level
  73.                 3) Keep a log of who goes into what door when
  74.                 4) Make sure you only stay in the doors menu while you have
  75.                    time remaining on the BBS
  76.                 5) Make user leave doors area if time left if 5 min. or less.
  77.                 6) Make the user return to the doors menu when they exit the
  78.                    door they have been in
  79.                 7) Create files for PC-BOARD v12.x & v14.x doors and RBBS
  80.                    v16.x & v17.x, Wildcat! v1.x & v2.x
  81.                 8) Replace user name with users real name for certain doors.
  82.                 9) Restrict certain doors to message posting users only.
  83.  
  84.  
  85. If you can help me to obtain file formats for BBS systems not listed here,
  86. please send them to:
  87.  
  88.                 Chester Johnson
  89.                 P.O. Box 7581
  90.                 Las Cruces, NM  88006-7581
  91.                 Voice: (505)521-1649
  92.  
  93. or call my board:
  94.  
  95.                 The Dragon's Lair
  96.                 BBS: (505)521-3314
  97.                 300/1200/2400
  98.                 Fido-Net node 1:305/108
  99.                 Trek-net node 87:6017/9001
  100.                 Starlink (tm) outdial port #6630
  101.  
  102.  
  103.  
  104.  
  105. Section 3:
  106. ==========
  107.  
  108.  
  109. Files included with DDMENU:
  110. ---------------------------
  111.  
  112.      ACUMSTAT.DAT   data used when scanning the callers file
  113.      ACUMSTAT.DOC   instructions for using ACUMSTAT.EXE
  114.      ACUMSTAT.DEF   sample of ACUMSTAT.DEF
  115.      ACUMSTAT.EXE   counts number of messages users have left & creates a
  116.                     bulletin
  117.      DD33CONV.DOC   instructions for using DD33CONV.EXE
  118.      DD33CONV.EXE   converts 3.3 data files to 4.0
  119.      DDINIT.EXE     the installation program
  120.      DDMAINT.EXE    used to maintain the menu definition file
  121.      DRAGDOOR.EXE   the menu program itself
  122.      DRAGDOOR.DOC   this file
  123.      INSTALL.BAT    the bat file to install everything
  124.      INSTALL.DOC    instructions for using the installation program
  125.      REGISTER.DOC   registration form (Please:  fill this out)
  126.      RESETCAL.DOC   instructions for using RESETCAL.EXE
  127.      RESETCAL.EXE   resets number of times a user has called to 0
  128.      USERUTIL.DEF   sample of USERUTIL.DEF
  129.  
  130.  
  131. Files created by DDINIT.EXE:
  132. ----------------------------
  133.  
  134.      DOORS.BAT      bat file called by RBBS in the RBBS directory
  135.      DOORS1.BAT     node 1 "return from doors" bat file
  136.      DORINFO0.DEF   test DORINFO file
  137.      DRAGDOR1.DEF   node 1 main definition file
  138.      TEST.BAT       testing bat file
  139.  
  140.  
  141. Files created by DDMAINT.EXE:
  142. -----------------------------
  143.  
  144.      DDMENU#.DEF    menu definition file for node "#"
  145.  
  146.  
  147. Files created by Dragdoor:
  148. --------------------------
  149.  
  150.      CALLINFO#.BBS  Wildcat v1.x & v2.x door information file for node number
  151.                     "#"
  152.      DORINFO#.DEF   RBBS v16.x and RBBS v17.x door user file
  153.      DRAGDOR#.USR   info on current doors user for node number "#"
  154.      DRAGLOG#       a log of who uses which door and when for node number "#"
  155.      MSGS           a small file that can be copies and renamed as MESSAGES or
  156.                     whatever you main messages file is called.  used in place
  157.                     of either copying your main messages file or giving a door
  158.                     access to your main messages file.
  159.      PCBOARD#.DAT   a file some PC-BOARD v12.x and 14.x doors look for, for 
  160.                     node number "#"
  161.      PCBOARD#.SYS   a file some PC-BOARD v12.x and v14.x doors look for, for
  162.                     node number "#"
  163.      RCTTY#.BAT     the bat file that runs the doors bat file for node # "#"
  164.  
  165.  
  166.  
  167. Section 4:
  168. ==========
  169.  
  170.  
  171. Doors Menu Maintenance Program:
  172. -------------------------------
  173.  
  174.   The program DDMAINT.EXE is used to add, change, or delete doors from the
  175. menu.
  176.  
  177.   The following is the information entered for each door.  Numbers 5-9 are
  178. optional.
  179.  
  180.                Prompt                         Meaning
  181.         ----------------------   ---------------------------------------------
  182.         1) MIN SECURITY LEVEL   The minimum security level required to access
  183.                                 this door
  184.  
  185.         2) DESCRIPTION          The description of the door shown to the users
  186.                                 (33 characters maximum)
  187.  
  188.         3) REMOTE BAT FILE      The name of the ".BAT" file that executes the
  189.                                 door if the user is logged on remotely.  This
  190.                                 BAT file will be executed always if there is
  191.                                 no LOCAL BAT FILE specified.
  192.  
  193.         4) BBS TYPE             The code for the type of BBS the door belons
  194.                                 on (* see below)
  195.  
  196.         5) ANSI REQUIRED (Y/N)  Does this door require ansi graphics?
  197.  
  198.         6) START TIME (HH:MM)   The beginning time of day this door is
  199.                                 accessable
  200.  
  201.         7) END TIME (HH:MM)     The ending time of day theis door is accessable
  202.  
  203.         8) MIN MSG/CALL RATIO   The minimum number of messages per call
  204.                                 required to access this door (can be a decimal
  205.                                 - ** see below)
  206.  
  207.         9) USE USER NAME FILE?  See Section 5
  208.  
  209.        10) USER-NAME FILE NAME  See Section 5
  210.  
  211.        11) LOCAL BAT FILE       The name of the ".BAT" file that executes the
  212.                                 door is the users is logged on locally.  The
  213.                                 REMOTE BAT FILE will be executed if the LOCAL
  214.                                 is not specified
  215.  
  216.        12) LOCK DOOR (Y/N)?     See Section 5
  217.  
  218.   Use the 'F1' key to save the current door or the 'ESC' key to return to the
  219. menu without saving it.
  220.  
  221.   * The valid BBS types are as follows:
  222.  
  223.         Type    BBS name
  224.         ------  ------------------------
  225.         PCB12   PC-Board v12.x
  226.         PCB14   PC-Board v14.x
  227.         QUICK   QuickBBS
  228.         RBBS16  RBBS v16.x
  229.         RBBS17  RBBS v17.x
  230.         WC1     Wildcat! v1.x
  231.         WC2     Wildcat! v2.x
  232.  
  233.  ** You must install ACUMSTAT.EXE before this option will work.
  234.  
  235.  
  236.  
  237. Section 5:
  238. ==========
  239.  
  240.  
  241. Features of Dragdoor menu program:
  242. ----------------------------------
  243.  
  244. 1)  Limit access by security level:  You are able to limit who may use a
  245.     specific door by giving it a security level.  No one with less than this
  246.     level will be able to access it.
  247.  
  248. 2)  Warn ANSI graphics is required:  If the user isn't set up for graphics the
  249.     menu will warn the user that the door requires ANSI graphics and will
  250.     verify that they still wish to enter it.
  251.  
  252. 3)  Time lock doors:  By setting a start and end time (using the 24 hour clock)
  253.     the menu will not let anyone access the door outside of the times specified
  254.  
  255. 4)  Messages per call ratio:  This allows you to keep people from using a door
  256.     if they don't have at least a certain number of messages per call.  When
  257.     you are installing the program you will be asked to enter the "MINIMUM
  258.     SECURITY LEVEL TO BE EXEMPT FROM THE MESSAGE/CALLS RATIO".  What ever
  259.     security level you enter (and higher) will be exempt from having to keep
  260.     there ratio up.  They will be able to go without posting any messages if
  261.     they wish and still be able to get into the doors with the ratio on them.
  262.  
  263. 5)  Real name & Private access:  This is a little misleading, this actually
  264.     means 'do you want to check a file you define for the existance of the
  265.     user?"  If you answer 'Y' then whenever a user tries to access this door,
  266.     it will check for their user name in the file.  If it doesn't find their
  267.     ID, they will not be aloud to enter the door and will be prompted to ask
  268.     the sysop for access to the door if they wish to use it.  If it does find
  269.     their name it will then substitute the "real" name given in this file for
  270.     their user name before calling this door.  The format of the file is as
  271.     follows:
  272.  
  273.     <user name>,<first name>,<last name>
  274.  
  275.     Eash user is on a separate line.  The last line MUST be:
  276.  
  277.     EOF,EOF,EOF
  278.  
  279.     The actual file name that it looks for is the one you tell it in prompt
  280.     #10 ("user-name file name").  This file must be in the same directory as
  281.     DRAGDOOR.EXE.
  282.  
  283.     I use this function to convert all my user's aliases into their real names
  284.     before calling the echo mail processor I use.  This way they send messages
  285.     with their real names and keep me out of trouble <grin>.  I also use it to
  286.     make sure only certain people get into certain doors (like subscriber only
  287.     games and member only echos).
  288.  
  289.  
  290. 6)  You can give specific people a different security level in the doors than
  291.     they have in the message bases.  To do this you must create a file called
  292.     DDSEC.  The format for this file is:
  293.  
  294.         <user name>,<user security level>
  295.  
  296.     Each user is on a separate line.  The last line MUST be:
  297.  
  298.         EOF,0
  299.  
  300.  
  301. 7)  Locking a Door:  If you wish to "lock" a door so that only one node at a
  302.     time can access it then answer 'Y' here.  For the lock to work the
  303.     DESCRIPTION that is entered must be EXACTLY the same on both nodes.  If
  304.     there is the slightest difference (even in upper to lower case) it will not
  305.     lock properly.  The reason to lock a door this way is that most doors can
  306.     only handle one node accessing them at a time.  Instead of having seperate
  307.     games for each node, this program lets you use the same one and it just
  308.     tells the 2nd user that the door is in use right now and they should try
  309.     back later.
  310.  
  311.  
  312. 8)  Multi-node capability:  Dragdoor has currently the capability to work on a
  313.     2 node system.  You must be using COM1 and COM2 for this to work (see
  314.     Section 7 for more details).  I have tested it using 2 nodes at a time and
  315.     have experienced no problems.  If you do, please contact me.
  316.  
  317.  
  318.  
  319. Section 6:
  320. ==========
  321.  
  322.  
  323. Update history:
  324. ---------------
  325.  
  326.  
  327. Version 1.1:
  328. ------------
  329.  
  330.   A) Version 1.0 had 2 major problems:
  331.  
  332.      1) it would only work on a single node
  333.      2) it did direct screen writes (this messes up your display if you are
  334.         using multi-tasking)
  335.  
  336.      These have been fixed in 1.1
  337.  
  338.   B) Added time remaining, security level, and other stuff to the top of the
  339.      screen.
  340.  
  341.  
  342. Version 1.2:
  343. ------------
  344.  
  345.   A) Creates the PC-BOARD.SYS file in the format PC-BOARD v14.0 doors need
  346.      when a door with a type of "PCB14" is entered.
  347.  
  348.  
  349. Version 2.0:
  350. ------------
  351.  
  352.   A) DTR drop problem fixed.
  353.  
  354.   B) Multi-node is now supported (I user 2, one dial-up and one local)
  355.      properly.
  356.  
  357.   C) Creates the PC-BOARD.SYS file in the format PC-BOARD v12.# doors need when
  358.      a door with a type of "PCB12" is entered.
  359.  
  360.   D) Re-wrote com port routines.
  361.  
  362.  
  363. Version 2.1:
  364. ------------
  365.  
  366.   A) Fixed time left bug, both on the screen and in the PCBOARD#.SYS &
  367.      DORINFO#.DEF files.
  368.  
  369.   B) Will make the user return to the BBS if there is 5 minutes or less left.
  370.  
  371.   C) Creates small MESSAGES file for use by the DOORS (file name = MSGS)
  372.  
  373.   D) Creates PCBOARD#.DAT files for v12.x & v14.x
  374.  
  375.   E) Changed the name of the filee from PC-BOARD.SYS to PCBOARD#.SYS
  376.  
  377.  
  378. Version 2.2:
  379. ------------
  380.  
  381.   A)  DDINIT.EXE installation program introduced.
  382.  
  383.   B)  Creates CALINFO#.BBS file for Wildcat! v1.x doors
  384.  
  385.   C)  Fixed bug in 'city and state' in DORINFO#.DEF FILE.
  386.  
  387.  
  388. Version 2.3:
  389. ------------
  390.  
  391.   A)  Creates CALINFO#.BBS file for Wildcat! v2.x doors
  392.  
  393.   B)  Modified the PCBOARD#.DAT file to fix a problem a few PCB door were
  394.       having
  395.  
  396.  
  397. Version 3.0:
  398. ------------
  399.  
  400.   A)  Restructured DDMENU#.DEF file
  401.  
  402.   B)  DDMAINT.EXE program introduced
  403.  
  404.   C)  Butchered the docs
  405.  
  406.   D)  No limit on the number of doors (used to be 15)
  407.  
  408.   E)  'REALNAME' file installed to handle the use of 'real name' inplace of
  409.       their sign on name for specified doors
  410.  
  411.  
  412. Version 3.1:
  413. ------------
  414.  
  415.   A)  DDSEC file added so users can have a different security level in the
  416.       doors.
  417.  
  418.   B)  Message/call ratio installed.
  419.  
  420.   C)  Added Acumstat files to archive.
  421.  
  422.  
  423. Version 3.2:
  424. ------------
  425.  
  426.   A)  Added QuickBBS command line.  See below.
  427.  
  428.  
  429. Version 3.3:
  430. ------------
  431.  
  432.   A)  Rewrote several routines including com port access.
  433.  
  434.   B)  Took out all direct screen writes in DRAGDOOR.EXE.
  435.  
  436.   C)  Included Resetcal files in archive.
  437.  
  438.   D)  Made so each door can have it's own "user-name" file.
  439.  
  440.   E)  Made so you must have the DTR-patched BRUN45.EXE in your path.
  441.  
  442.  
  443. Version 4.0:
  444. ------------
  445.  
  446.   A)  Now calls the door with the node number in the command line.
  447.  
  448.   B)  Lets you specify seperate BAT files for local and remote access.
  449.  
  450.   C)  Lets you lock doors so only one node can access certain doors at a time.
  451.  
  452.   D)  Fixed bugs in DDINIT.EXE.
  453.  
  454.   E)  Upgrade program first introduced.
  455.  
  456.  
  457.  
  458. Section 7:
  459. ==========
  460.  
  461.  
  462. ACKNOWLEDGEMENTS:
  463. -----------------
  464.  
  465. I wish to extend special thanks to Mike Sylvestre, Sysop of The Micro-Imaging
  466. BBS (407-847-5499), for his help in setting up the PC-BOARD formats and
  467. helping in fixing the DTR drop problem.  Mike has also been helpful to some
  468. sysops in getting Dragdoor operating when they couldn't get ahold of me.
  469.  
  470. Also thanks to Jeffry Brickley (assistant sysop for The Dragon's Lair) for help
  471. in programming.
  472.  
  473.  
  474.  
  475. Section 8:
  476. ==========
  477.  
  478.  
  479. IMPORTANT!!!!!:
  480. ---------------
  481.  
  482.  
  483. About RBBS16 & RBBS17:
  484. ----------------------
  485.  
  486.   When you choose a door labeled as RBBS16 or RBBS17, the DORINFO#.DEF file is
  487. going to be updated and a file called MSGS will be created.  You may need to
  488. copy DORINFO#.DEF into the individual doors directory.  If the door requires
  489. access to the MESSAGES file, just copy MSGS over to the individual doors
  490. directory and rename it as MESSAGES.
  491.  
  492.  
  493. About PCB12 & PCB14:
  494. --------------------
  495.  
  496.   When you choose a door labeled as PCB12 or PCB14, 2 files are created.
  497. PCBOARD#.SYS and PCBOARD#.DAT.  You will need to copy these to the individual
  498. doors directory (and possibly rename them) if they are required.
  499.  
  500.  
  501. About Wildcat! v1.x & v2.x:
  502. ---------------------------
  503.  
  504.   When you choose a door labeled as WC! the CALINFO#.BBS file is created.  You
  505. will need to copy this file to the individual door directory and rename it as
  506. CALLINFO.BBS for most Wildcat! v1.x & v2.x doors to work.
  507.  
  508.  
  509. About QuickBBS:
  510. ---------------
  511.  
  512.   When you choose a door labeled WUICK the bat file called will be called with
  513. parameters like this:
  514.  
  515. GAME.BAT <user fir name> <user last name> <time left> <com port number>
  516.  
  517. I have this running the Operation: Overkill door by Nulfenstein Productions
  518.  
  519.  
  520. About message/call ratio:
  521. -------------------------
  522.  
  523.   When you first install this option you should first delete your callers file
  524. and run RESETCAL.EXE.  This way everyone starts out with 0 messages and 0
  525. calls.  You will only have the current days log abailable while you are using
  526. this option, otherwise it will misscount the number of messages posted.
  527.  
  528.  
  529. About Comport addresses:
  530. ------------------------
  531.  
  532.   Dragdoor right now only works for COM1 and COM2.  The address for COM1 is 3F8
  533. and the address for COM2 is 2F8.  If your system does not have these setup this
  534. way Dragdoor will NOT work properly.
  535.  
  536.  
  537.  
  538. Section 9:
  539. ==========
  540.  
  541.  
  542. What the heck happens when I use Dragdoor?
  543. ------------------------------------------
  544.  
  545.      WARNING:  DO NOT READ THIS IF YOU DON'T WANT TO BE CONFUSED, LORD KNOWS 
  546. THAT I HAVE BEEN EVER SINCE I STARTED THIS PROJECT.
  547.  
  548.      When you type 'D' then 'DOORS' in RBBS, RBBS creates a file called 
  549. RCTTY.BAT (or whatever you have it defined as in the RBBS CONFIG file).  Then 
  550. it drops back to your RBBS.BAT file and then executes the RCTTY.BAT file.  
  551. RCTTY.BAT then executes the DOORS.BAT file (created by the DDINIT.EXE program 
  552. when you installed Dragdoor).
  553.      DOORS.BAT changes to the doors directory and copies DORINFO#.DEF (where 
  554. '#' is the node number the user is on) into the doors directory.  Then it 
  555. deletes the DRAGDOR1.USR file and finally executes DRAGDOOR.EXE.
  556.      Next you select a door from the ones displayed.  Then DRAGDOOR.EXE 
  557. creates the files necessary for that type of door and then returns to the 
  558. DOOR.BAT file.  Then DOORS.BAT excutes RCTTY#.BAT (where '#' is the node 
  559. number - this file was also just created by DRAGDOOR.EXE prior to exiting).
  560.      RCTTY1.BAT executes the bat file that runs the door (ex:  MOTU.BAT for 
  561. Master of the Universe.  From here on in I will use MOTU.BAT to mean the bat 
  562. file that actually executes the door).  MOTU.BAT then copies the files 
  563. necessary to the proper directory (if needed) and runs the door itself.
  564.      When you exit the door the control is returned to MOTU.BAT which then 
  565. executes the DOORS1.BAT file, which in turn calls DRAGDOOR.EXE again.
  566.      When you just hit enter while at the Dragdoor menu, it will then take you 
  567. back to RBBS.BAT instead of executing a bat file to run a specific door (like 
  568. MOTU.BAT).
  569.  
  570.  
  571. Flow chart of the mess I just described:
  572. ----------------------------------------
  573.  
  574. RBBS.EXE --> RBBS.BAT --> RCTTY.BAT --> DOORS.BAT --> DRAGDOOR.EXE ----------
  575.                                                                              |
  576.                                                                              |
  577. DOORS1.BAT <-- door bat file <-- door prog <-- door bat file <-- DOORS.BAT <-
  578. |                                                                   ^
  579. |                                                                   |
  580.  -> DRAGDOOR.EXE ---------------------------------------------------
  581.         |
  582.          --> RBBS.BAT (if no door was selected at the menu)
  583.  
  584.  
  585.  
  586. Section 10:
  587. ===========
  588.  
  589.      If you are using version 3.2 or earlier, you must delete everything
  590. associated with Dragdoor and so an INSTALL as if you hadn't been using it
  591. before.
  592.  
  593.      If you are using version 3.3 just replace the EXE files and run DD33CONV.
  594. Then run DDMAINT.EXE and modify options 9 & 12 for those each doors that need
  595. it.
  596.  
  597.  
  598.  
  599.  
  600.                              ----------------------
  601.                              |END OF DOCUMANTATION|
  602.                              ----------------------
  603.  
  604.